Polycom Actions

Polycom has three different types of Actions:

  1. Phone Services

  2. Phone Services Dialer

  3. Dial Monitor

Get Polycom Actions

Retrieve all Polycom actions by issuing a GET on the below URL.

GET: http:// <ServerIP>/unifiedgui/webapi/Polycom/Actions/

This will return a collection of Actions objects which could be a mix of the above-mentioned Action types.

GET: http://<ServerIP>/unifiedgui/webapi/Polycom/Action(actionId=b0c5b73e-39ff-e811-80cf-0050568f0d00)

The above will return a specific Action with Id.

 

[Note: Query filters may be applied on the Actions object. Refer to Query Methods portion of the document for more information]

Phone Service Actions Object

Name (required)

The name of action you are creating.

Site

Provide a Site (name) to associate the action.

A null or empty string for Site defaults the action to AllSites, i.e. The action will be available to all Sites configured in Revolution .

URL

This is not a create or update property but will be provided on all GET of an actions. This is a dynamically generated callback URL to trigger this action.

Add or Update Polycom Actions

Actions may be added/updated in collections of Actions objects.

POST: http://<ServerIP>/unifiedgui/webapi/Polycom/PhoneService/
Example Request
  • This POST request adds one new PhoneService and updates another existing PhoneService (Note: the object with ‘Id’)

{  "actions" : [
    {
      "Name":"PhoneService_1",
      "Site":""
    },
    {
      "Id": "0b739e18-22a2-eb11-84f2-54bf64846080",
      "Name":"PhoneService_2",
      "Site" : "San Jose site"
    }
  ]
}
Example Response
{
"Ok": true,
"Successes":[
{
"Id": "36a173f7-d026-4d76-8458-321e7f2eff47",
"Name": " PhoneService_1",
"Message": null
},
{
"Id": "0b739e18-22a2-eb11-84f2-54bf64846080",
"Name": " PhoneService_2",
"Message": null
}
],
"Failures":[]

Phone Service Dialer Actions Object

Name (required)

The name of action you are creating.

Site

Provide a Site (name) to associate the action.

A null or empty string for Site defaults the action to AllSites, i.e. The action will be available to all Sites configured in Revolution .

Extension

Dial an extension directly

URL

This is not a create or update property but will be provided on all GET of an actions. This is a dynamically generated callback URL to trigger this action.

Actions may be added/updated in collections of Actions objects.

POST: http://<ServerIP>/unifiedgui/webapi/Polycom/PhoneServiceDialer/

Follow the same example as provided for PhoneService

Polycom Dial Monitor Actions Object

Name (required)

The name of action you are creating.

Site

Provide a Site (name) to associate the action.

A null or empty string for Site defaults the action to AllSites, i.e. The action will be available to all Sites configured in Revolution .

MonitoredNumber (required)

Enter specific number to monitor or use ? and * wildcards (?11 matches 911 and 411; 2* matches any number dialed beginning with 2)

Actions may be added/updated in collections of Actions objects.

POST: http://<ServerIP>/unifiedgui/webapi/Polycom/DialMonitor/

Follow the same example as provided for PhoneService

Delete Polycom Actions

Delete Polycom Actions by sending a collection of Ids of actions that need to be deleted.

POST: http://<ServerIP>/unifiedgui/webapi/Polycom/DeleteActions/
Example Request
  • This POST deletes actions with below IDs.

{  "ids" : ["68782574-051a-4000-b585-a056edbbf2fa", “7sdf42574-051a-4000-b585-a056edbbf2fa”]}